Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin.services/CollectionService

CollectionService

class CollectionService(client: PocketbaseClient) : CrudService<Collection>

Constructors

CollectionService

constructor(client: PocketbaseClient)

Properties

baseCrudPath

open override val baseCrudPath: String

The url path to the service's API

client

val client: PocketbaseClient

Functions

_create

inline suspend fun <T : BaseModel> _create(path: String, body: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

inline suspend fun <T : BaseModel> _create(path: String, body: Map<String, JsonPrimitive>, files: List<FileUpload>, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

_delete

inline suspend fun _delete(path: String, id: String): Boolean

_getFullList

inline suspend fun <T : BaseModel> _getFullList(path: String, batch: Int, sortBy: SortFields = SortFields(), filterBy: Filter = Filter(), expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields(), skipTotal: Boolean = false): List<T>

_getList

inline suspend fun <T : BaseModel> _getList(path: String, page: Int, perPage: Int, sortBy: SortFields = SortFields(), filterBy: Filter = Filter(), expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields(), skipTotal: Boolean = false): ListResult<T>

_getOne

inline suspend fun <T : BaseModel> _getOne(path: String, id: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

_update

inline suspend fun <T : BaseModel> _update(path: String, id: String, body: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

inline suspend fun <T : BaseModel> _update(path: String, id: String, body: Map<String, JsonPrimitive>, files: List<FileUpload>, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

create

inline suspend fun <T : BaseModel> create(body: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

inline suspend fun <T : BaseModel> create(body: Map<String, JsonPrimitive>, files: List<FileUpload>, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

Creates a new record and gets the record

delete

inline suspend fun delete(id: String): Boolean

Deletes the specified record

getFullList

inline suspend fun <T : BaseModel> getFullList(batch: Int, sortBy: SortFields = SortFields(), filterBy: Filter = Filter(), expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields(), skipTotal: Boolean = false): List<T>

Fetches all records in the collection at once

getList

inline suspend fun <T : BaseModel> getList(page: Int, perPage: Int, sortBy: SortFields = SortFields(), filterBy: Filter = Filter(), expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields(), skipTotal: Boolean = false): ListResult<T>

Fetches a paged list of records

getOne

inline suspend fun <T : BaseModel> getOne(id: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

Fetches a single record

getScaffolds

suspend fun getScaffolds(): JsonObject

Returns an object will all of the collection types and their default fields (used primarily in the Dashboard UI).

import

suspend fun import(collections: List<Collection>, deleteMissing: Boolean = false): Boolean

Bulk imports the provided Collections configuration.

truncate

suspend fun truncate(collection: String): Boolean

Deletes all the records of a single collection (including their related files and cascade delete enabled relations).

update

inline suspend fun <T : BaseModel> update(id: String, body: String, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

inline suspend fun <T : BaseModel> update(id: String, body: Map<String, JsonPrimitive>, files: List<FileUpload>, expandRelations: ExpandRelations = ExpandRelations(), showFields: ShowFields = ShowFields()): T

Updates an existing records and gets it